Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

address-objects #3

Merged
merged 12 commits into from
Oct 10, 2024
Merged

address-objects #3

merged 12 commits into from
Oct 10, 2024

Conversation

cdot65
Copy link
Owner

@cdot65 cdot65 commented Oct 10, 2024

Checklist for This Pull Request

🚨Please adhere to the guidelines for contributing to this repository.

  • Ensure you are submitting your pull request to a branch dedicated to a specific topic/feature/bugfix. Avoid using the master branch for pull requests.
  • Target your pull request to the main development branch in this repository.
  • Ensure your commit messages follow the project's preferred format.
  • Check that your code additions do not fail any linting checks or unit tests.

Pull Request Description

Update README.md

What does this pull request accomplish?

  • Documentation update

Are there any breaking changes included?

  • Yes
  • No

Is there anything the reviewers should know?

Thank you for your contributions!

cdot65 added 12 commits October 9, 2024 20:49
Deleted the outdated .idea/.gitignore file and migrated its contents to the main .gitignore file. This consolidates all ignore rules and improves project configuration clarity.
This commit deletes the .idea/modules.xml file. This change helps to clean up project-specific configuration files not necessary for version control.
The file pan-scm-sdk.iml is specific to IntelliJ IDEA and should not be tracked in the repository. This change helps prevent unnecessary file clutter and potential merge conflicts.
Introduced address, address group, and application endpoints to the `API_ENDPOINTS` dictionary. Defined new custom exception classes: `NotFoundError`, and `ConflictError`. All __init__.py files are also updated to ensure they end with a newline.
Introduce new test cases for `AddressClient` to validate `list_addresses` and `get_address` methods using mock responses. Extend coverage for the `Address` model by testing valid and invalid scenarios related to address types and containers.
Removed the entire `authentication.py` file due to unused exceptions. Enhanced the `AuthRequest` class with better documentation and added a new `AddressClient` class for address management. Additionally, improved error handling in `APIClient` and added logging.
Introduced three new modules containing endpoint definitions for addresses, applications, and address groups within the pan_scm_sdk package. These modules include CRUD endpoint mappings to streamline API interactions for these entities.
Enhanced OAuth2Client with an extensive docstring explaining its purpose, attributes, errors, and return values. This improves code maintainability and clarity for future developers.
Introduce a new Mermaid file to visualize the class relationships within the SDK. The diagram includes various nodes representing classes and their methods, enhancing the documentation's comprehensibility.
Previously, the `id` field was a required attribute for the Address model. This change makes the `id` field optional, providing more flexibility for instances where an ID may not yet be assigned.
Enhanced README.md to include comprehensive usage examples for authentication, creating, listing, updating, and deleting address objects. Added detailed descriptions of key features such as OAuth2 authentication, resource management, data validation, and exception handling.
# Conflicts:
#	pan_scm_sdk/models/address.py
@cdot65 cdot65 merged commit 183c369 into main Oct 10, 2024
1 check passed
@cdot65 cdot65 deleted the address-objects branch October 10, 2024 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant